<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>OCILIB (C and C++ Driver for Oracle): ocilib::Agent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">OCILIB (C and C++ Driver for Oracle)
   &#160;<span id="projectnumber">4.2.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>About</span></a></li>
      <li><a href="modules.html"><span>Documentation</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classocilib_1_1_agent.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="classocilib_1_1_agent-members.html">List of all members</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">ocilib::Agent Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>AQ identified agent for messages delivery.  
 <a href="classocilib_1_1_agent.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="ocilib_8hpp_source.html">ocilib.hpp</a>&gt;</code></p>

<p>Inherits <a class="el" href="classocilib_1_1_handle_holder.html">ocilib::HandleHolder&lt; OCI_Agent * &gt;</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:affb689fd24c780f9e25d713c042ddf45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classocilib_1_1_agent.html#affb689fd24c780f9e25d713c042ddf45">Agent</a> (const <a class="el" href="classocilib_1_1_connection.html">Connection</a> &amp;connection, const <a class="el" href="namespaceocilib.html#a01daa07e307e429b66fb80f442362237">ostring</a> &amp;name=OTEXT(&quot;&quot;), const <a class="el" href="namespaceocilib.html#a01daa07e307e429b66fb80f442362237">ostring</a> &amp;address=OTEXT(&quot;&quot;))</td></tr>
<tr class="memdesc:affb689fd24c780f9e25d713c042ddf45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an AQ agent object.  <a href="#affb689fd24c780f9e25d713c042ddf45">More...</a><br /></td></tr>
<tr class="separator:affb689fd24c780f9e25d713c042ddf45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a787ac94599157fcf8b705c13959d3ac4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a787ac94599157fcf8b705c13959d3ac4"></a>
<a class="el" href="namespaceocilib.html#a01daa07e307e429b66fb80f442362237">ostring</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classocilib_1_1_agent.html#a787ac94599157fcf8b705c13959d3ac4">GetName</a> () const </td></tr>
<tr class="memdesc:a787ac94599157fcf8b705c13959d3ac4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the given AQ agent name. <br /></td></tr>
<tr class="separator:a787ac94599157fcf8b705c13959d3ac4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cf39298ceae611b2499244e97c23baa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classocilib_1_1_agent.html#a8cf39298ceae611b2499244e97c23baa">SetName</a> (const <a class="el" href="namespaceocilib.html#a01daa07e307e429b66fb80f442362237">ostring</a> &amp;value)</td></tr>
<tr class="memdesc:a8cf39298ceae611b2499244e97c23baa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the given AQ agent name.  <a href="#a8cf39298ceae611b2499244e97c23baa">More...</a><br /></td></tr>
<tr class="separator:a8cf39298ceae611b2499244e97c23baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38c512bd8c74f938a77dc6b76f77b09c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceocilib.html#a01daa07e307e429b66fb80f442362237">ostring</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classocilib_1_1_agent.html#a38c512bd8c74f938a77dc6b76f77b09c">GetAddress</a> () const </td></tr>
<tr class="memdesc:a38c512bd8c74f938a77dc6b76f77b09c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the given AQ agent address.  <a href="#a38c512bd8c74f938a77dc6b76f77b09c">More...</a><br /></td></tr>
<tr class="separator:a38c512bd8c74f938a77dc6b76f77b09c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44b3a42c020de9077c1ddeab63d0f5fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classocilib_1_1_agent.html#a44b3a42c020de9077c1ddeab63d0f5fd">SetAddress</a> (const <a class="el" href="namespaceocilib.html#a01daa07e307e429b66fb80f442362237">ostring</a> &amp;value)</td></tr>
<tr class="memdesc:a44b3a42c020de9077c1ddeab63d0f5fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the given AQ agent address.  <a href="#a44b3a42c020de9077c1ddeab63d0f5fd">More...</a><br /></td></tr>
<tr class="separator:a44b3a42c020de9077c1ddeab63d0f5fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>AQ identified agent for messages delivery. </p>
<p>This class wraps the OCILIB object handle OCI_Agent and its related methods </p>

<p>Definition at line <a class="el" href="ocilib_8hpp_source.html#l06974">6974</a> of file <a class="el" href="ocilib_8hpp_source.html">ocilib.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="affb689fd24c780f9e25d713c042ddf45"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ocilib::Agent::Agent </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classocilib_1_1_connection.html">Connection</a> &amp;&#160;</td>
          <td class="paramname"><em>connection</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="namespaceocilib.html#a01daa07e307e429b66fb80f442362237">ostring</a> &amp;&#160;</td>
          <td class="paramname"><em>name</em> = <code>OTEXT(&quot;&quot;)</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="namespaceocilib.html#a01daa07e307e429b66fb80f442362237">ostring</a> &amp;&#160;</td>
          <td class="paramname"><em>address</em> = <code>OTEXT(&quot;&quot;)</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create an AQ agent object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">connection</td><td>- <a class="el" href="classocilib_1_1_connection.html" title="A connection or session with a specific database. ">Connection</a> object </td></tr>
    <tr><td class="paramname">name</td><td>- <a class="el" href="classocilib_1_1_agent.html" title="AQ identified agent for messages delivery. ">Agent</a> name </td></tr>
    <tr><td class="paramname">address</td><td>- <a class="el" href="classocilib_1_1_agent.html" title="AQ identified agent for messages delivery. ">Agent</a> address</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>An AQ agent object is :<ul>
<li>used as recipient information when enqueuing a message</li>
<li>used as sender information when dequeuing a message</li>
<li>used for listening message only from identified senders</li>
</ul>
</dd>
<dd>
the AQ agent address can be any Oracle identifier, up to 128 bytes. the AQ agent name can be any Oracle identifier, up to 30 bytes.</dd>
<dd>
the <a class="el" href="classocilib_1_1_agent.html" title="AQ identified agent for messages delivery. ">Agent</a> object must not be accessed anymore once the parent connection object gets out of scope </dd></dl>

<p>Definition at line <a class="el" href="ocilib__impl_8hpp_source.html#l06123">6123</a> of file <a class="el" href="ocilib__impl_8hpp_source.html">ocilib_impl.hpp</a>.</p>

<p>References <a class="el" href="namespaceocilib.html#ada9a964035fd103d4ec07500f404a658">ocilib::Check()</a>, <a class="el" href="group___ocilib_c_api_advanced_queuing.html#ga8e88d0c072cdb072b3c39d64bf4bc0de">OCI_AgentCreate()</a>, and <a class="el" href="group___ocilib_c_api_advanced_queuing.html#ga0b690cf393387147d9d474adab89b5c0">OCI_AgentFree()</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8cf39298ceae611b2499244e97c23baa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void ocilib::Agent::SetName </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceocilib.html#a01daa07e307e429b66fb80f442362237">ostring</a> &amp;&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set the given AQ agent name. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">value</td><td>- AQ agent name</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>the AQ agent name is used to identified an message send or recipient when enqueuing/dequeuing a message</dd>
<dd>
the AQ agent name can be any Oracle identifier, up to 30 bytes. </dd></dl>

<p>Definition at line <a class="el" href="ocilib__impl_8hpp_source.html#l06138">6138</a> of file <a class="el" href="ocilib__impl_8hpp_source.html">ocilib_impl.hpp</a>.</p>

<p>References <a class="el" href="namespaceocilib.html#ada9a964035fd103d4ec07500f404a658">ocilib::Check()</a>, and <a class="el" href="group___ocilib_c_api_advanced_queuing.html#gae380663fe72ce3d6d5139833e86e1078">OCI_AgentSetName()</a>.</p>

</div>
</div>
<a class="anchor" id="a38c512bd8c74f938a77dc6b76f77b09c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceocilib.html#a01daa07e307e429b66fb80f442362237">ostring</a> ocilib::Agent::GetAddress </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the given AQ agent address. </p>
<dl class="section note"><dt>Note</dt><dd>See <a class="el" href="classocilib_1_1_agent.html#a44b3a42c020de9077c1ddeab63d0f5fd" title="Set the given AQ agent address. ">SetAddress()</a> for more details </dd></dl>

<p>Definition at line <a class="el" href="ocilib__impl_8hpp_source.html#l06143">6143</a> of file <a class="el" href="ocilib__impl_8hpp_source.html">ocilib_impl.hpp</a>.</p>

<p>References <a class="el" href="namespaceocilib.html#ada9a964035fd103d4ec07500f404a658">ocilib::Check()</a>, <a class="el" href="namespaceocilib.html#a5cd1f7bf7b526707a602632ac2d657f0">ocilib::MakeString()</a>, and <a class="el" href="group___ocilib_c_api_advanced_queuing.html#ga7005397ffe16f80f9c981771a40b4703">OCI_AgentGetAddress()</a>.</p>

</div>
</div>
<a class="anchor" id="a44b3a42c020de9077c1ddeab63d0f5fd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void ocilib::Agent::SetAddress </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceocilib.html#a01daa07e307e429b66fb80f442362237">ostring</a> &amp;&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set the given AQ agent address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">value</td><td>- AQ agent address</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>the parameter 'address' must be of the form : [schema.]queue_name[@dblink]</dd>
<dd>
the AQ agent address can be any Oracle identifier, up to 128 bytes. </dd></dl>

<p>Definition at line <a class="el" href="ocilib__impl_8hpp_source.html#l06148">6148</a> of file <a class="el" href="ocilib__impl_8hpp_source.html">ocilib_impl.hpp</a>.</p>

<p>References <a class="el" href="namespaceocilib.html#ada9a964035fd103d4ec07500f404a658">ocilib::Check()</a>, and <a class="el" href="group___ocilib_c_api_advanced_queuing.html#ga94cce2ed17c10327c230238ec192892e">OCI_AgentSetAddress()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceocilib.html">ocilib</a></li><li class="navelem"><a class="el" href="classocilib_1_1_agent.html">Agent</a></li>
    <li class="footer">Generated on Mon Mar 21 2016 22:26:38 for OCILIB (C and C++ Driver for Oracle) by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
  </ul>
</div>
</body>
</html>
